Skip to content

chore: plugin manifest definition #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
MarioCadenas wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: plugin manifest definition #82

MarioCadenas wants to merge 3 commits into from

Conversation

@MarioCadenas
Copy link
Collaborator

@MarioCadenas MarioCadenas commented Feb 3, 2026 •
edited
Loading

This PR introduces the definition for manifests, resources and so on for plugins plus the manifests for both analytics and server plugin

Base automatically changed from refactor-move-core-plugins to main February 4, 2026 10:33
@MarioCadenas MarioCadenas force-pushed the plugin-manifest-definition branch 2 times, most recently from d218b64 to 0c73331 Compare February 4, 2026 11:00
@MarioCadenas
chore: plugin manifest definition
eb19da1 
chore: make plugin manifest required

All plugins must now declare a static manifest property with their
metadata and resource requirements. This simplifies the manifest loader
and provides better error messages.
@MarioCadenas MarioCadenas force-pushed the plugin-manifest-definition branch from 0c73331 to eb19da1 Compare February 4, 2026 13:18
@MarioCadenas
chore: implement manifest loader (#83)
14b339e 
Implement manifest loader with validation and error handling.
All plugins must have a static manifest property.

Features:
- getPluginManifest() - loads and validates plugin manifests
- getResourceRequirements() - extracts resource requirements
- Comprehensive validation with clear error messages
- Unit tests and integration tests with core plugins
@MarioCadenas MarioCadenas force-pushed the plugin-manifest-definition branch from 780c458 to 14b339e Compare February 4, 2026 13:28
@MarioCadenas MarioCadenas marked this pull request as ready for review February 4, 2026 13:32
@MarioCadenas MarioCadenas requested a review from pkosiec February 4, 2026 13:32
pkosiec
pkosiec reviewed Feb 4, 2026
View reviewed changes
Copy link
Member

@pkosiec pkosiec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM, just small comments

docs/docs/api/appkit/Enumeration.ResourceType.md
Copy link
Member

@pkosiec pkosiec Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something went wrong with displaying an icon near to the enum in the docs - it falls-back to the "other" category, but it should use enum:

appkit/docs/src/css/custom.css

Lines 112 to 116 in 8dceeb4

.api-kind-enum .menu__link::before {
border-color: var(--api-kind-enum-color);
color: var(--api-kind-enum-color);
content: "E";
}

appkit/docs/sidebars.ts

Lines 35 to 46 in b70ea1c

for (const subItem of item.items) {
// Extract kind from the id (e.g., "Function." from "api/appkit/Function.name")
// To get "function", "class", "interface", etc.
const idParts = subItem.id.split("/").pop() || "";
const rawKind = idParts.split(".")[0].toLowerCase();
const kind = SUPPORTED_KINDS.has(rawKind) ? rawKind : "other";
flatItems.push({
...subItem,
className: `api-kind-${kind}`,
});
}

Could you please check? maybe it's just named "enumeration" or sth, and the fix will be easy. Thanks!

image

packages/appkit/src/plugin/plugin.ts
]);

/** Base abstract class for creating AppKit plugins */
/**
Copy link
Member

@pkosiec pkosiec Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome you documented this 👌

packages/appkit/src/plugins/analytics/manifest.ts
Comment on lines +32 to +45
timeout: {
type: "number",
default: 30000,
description: "Query execution timeout in milliseconds",
},
queriesDir: {
type: "string",
description: "Directory containing SQL query files",
},
cacheEnabled: {
type: "boolean",
default: true,
description: "Enable query result caching",
},
Copy link
Member

@pkosiec pkosiec Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Timeout is defined on the constructor level, but what about the other properties? 🤔

appkit/packages/appkit/src/plugins/analytics/types.ts

Lines 3 to 5 in 2e1be40

export interface IAnalyticsConfig extends BasePluginConfig {
timeout?: number;
}

packages/appkit/src/registry/types.ts
* Configuration schema definition for plugin config.
* Uses JSON Schema format for validation and documentation.
*/
export interface ConfigSchema {
Copy link
Member

@pkosiec pkosiec Feb 4, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should already use existing JSON schema types from some library? I believe at some point we'll use some lib to validate the configuration, right?

(totally fine to skip this comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pkosiec pkosiec pkosiec left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MarioCadenas @pkosiec